/**
 *    Copyright (C) 2023-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */
#pragma once

#include <clang-tidy/ClangTidy.h>
#include <clang-tidy/ClangTidyCheck.h>

namespace mongo::tidy {

/**
    Overrides the default PPCallback class to primarily override
    the InclusionDirective call which is called for each include included. This
    allows the chance to evaluate specifically the include and determine whether
    it is considered a "mongo" include or not and if it is using the appropriate include style.
*/
class MongoHeaderIncludePathCheck : public clang::tidy::ClangTidyCheck {
public:
    MongoHeaderIncludePathCheck(clang::StringRef Name, clang::tidy::ClangTidyContext* Context);
    void storeOptions(clang::tidy::ClangTidyOptions::OptionMap& Opts) override;
    void registerPPCallbacks(const clang::SourceManager& SM,
                             clang::Preprocessor* PP,
                             clang::Preprocessor* ModuleExpanderPP) override;
    // used to store option `mongoSourceDirs`; supports both absolute and relative paths
    std::vector<llvm::StringRef> mongoSourceDirs;

    // The path component that denotes the repo's root source directory (default: "src").
    // Used to compute canonical include paths "from src/".
    std::string srcRootComponent;
};

}  // namespace mongo::tidy
